<?php 

class dof_im_guestbook implements dof_plugin_im {
    
    /**
     * @var dof_control
     */
    protected $dof;
    // **********************************************
    // Методы, предусмотренные интерфейсом plugin
    // **********************************************
    /**
     * Метод, реализующий инсталяцию плагина в систему
     * Создает или модифицирует существующие таблицы в БД
     * и заполняет их начальными значениями
     * @return boolean
     * Может надо возвращать массив с названиями таблиц и результатами их создания?
     * чтобы потом можно было распечатать сообщения о результатах обновления
     * @access public
     */
    public function install()
    {
        if ( ! parent::install() )
        {
            return false;
        }
        
        return $this->dof->storage('acl')->save_roles($this->type(),$this->code(),$this->acldefault());
    }
    /**
     * Метод, реализующий обновление плагина в системе
     * Создает или модифицирует существующие таблицы в БД
     * @param string $old_version - версия установленного в системе плагина
     * @return boolean
     * Может надо возвращать массив с названиями таблиц и результатами их создания/изменения?
     * чтобы потом можно было распечатать сообщения о результатах обновления
     * @access public
     */
    public function upgrade($oldversion)
    {
        global $CFG;
        require_once($CFG->libdir.'/ddllib.php');//методы для установки таблиц из xml
        $result = true;
        // Модификация базы данных через XMLDB
        // if ($result && $oldversion < 2008121000)
        // {

        // }
        // обновляем права доступа, если есть такая необходимость
        return ( $result AND $this->dof->storage('acl')->save_roles($this->type(),$this->code(),$this->acldefault()) );
    }
    /**
     * Возвращает версию установленного плагина
     * @return string
     * @access public
     */
    public function version()
    {
        return 2012092011;
    }
    /**
     * Возвращает версии интерфейса Деканата,
     * с которыми этот плагин может работать
     * @return string
     * @access public
     */
    public function compat_dof()
    {
        return 'aquarium';
    }
    
    /**
     * Возвращает версии стандарта плагина этого типа,
     * которым этот плагин соответствует
     * @return string
     * @access public
     */
    public function compat()
    {
        return 'angelfish';
    }
    
    /**
     * Возвращает тип плагина
     * @return string
     * @access public
     */
    public function type()
    {
        return 'im';
    }
    /**
     * Возвращает короткое имя плагина
     * Оно должно быть уникально среди плагинов этого типа
     * @return string
     * @access public
     */
    public function code()
    {
        return 'guestbook';
    }
    /**
     * Возвращает список плагинов,
     * без которых этот плагин работать не может
     * @return array
     * @access public
     */
    public function need_plugins()
    {
        return array('storage'=>array('acl'=>2011040504));
    }
    /**
     * Список обрабатываемых плагином событий
     * @return array - array(array('plugintype'=>..,'plugincode'=>..,'eventcode'=>..),...)
     * @access public
     */
    public function list_catch_events()
    {
        return array();
    }
    /**
     * Требуется ли запуск cron в плагине
     * @return bool
     * @access public
     */
    public function is_cron()
    {
        // Этому плагину не нужен крон
        return false;
    }
    
    /** Проверяет полномочия на совершение действий
     * @param string $do - идентификатор действия, которое должно быть совершено
     * @param int $id_obj - идентификатор экземпляра объекта,
     * по отношению к которому это действие должно быть применено
     * @param int $user_id - идентификатор пользователя, полномочия которого проверяются
     * @return bool true - можно выполнить указанное действие по отношению к выбранному объекту
     * false - доступ запрещен
     * @access public
     */
    public function is_access($do, $objid = NULL, $userid = NULL)
    {   
        if ( $this->dof->is_access('datamanage') OR $this->dof->is_access('admin')
                OR $this->dof->is_access('manage') )
        {// манагеру можно все
            return true;
        }
        // проверяем права, используя систему полномочий acl
        if ( $this->acl_access_check($do, $objid, $userid) )
        {// права есть - все нормально
            return true;
        }
        return false;
    }
    /** Требует наличия полномочия на совершение действий
     * @param string $do - идентификатор действия, которое должно быть совершено
     * @param int $id_obj - идентификатор экземпляра объекта,
     * по отношению к которому это действие должно быть применено
     * @param int $user_id - идентификатор пользователя, полномочия которого проверяются
     * @return bool true - можно выполнить указанное действие по отношению к выбранному объекту
     * false - доступ запрещен
     * @access public
     */
    public function require_access($do, $objid = NULL, $userid = NULL)
    {
        if ( ! $this->is_access($do, $objid, $userid) )
        {
            $notice = "guestbook/{$do} (block/dof/im/guestbook: {$do})";
            if ($objid)
            {
                $notice.=" id={$objid}";
            }
            $this->dof->print_error('nopermissions','',$notice);
        }
    }
    
    /**
    * Обработать событие
    * @param string $gentype - тип модуля, сгенерировавшего событие
    * @param string $gencode - код модуля, сгенерировавшего событие
    * @param string $eventcode - код задания
    * @param int $intvar - дополнительный параметр
    * @param mixed $mixedvar - дополнительные параметры
    * @return bool - true в случае выполнения без ошибок
    * @access public
    */
    public function catch_event($gentype,$gencode,$eventcode,$intvar,$mixedvar)
    {
        return true;
    }

    /**
    * Запустить обработку периодических процессов
    * @param int $loan - нагрузка (1 - только срочные, 2 - нормальный режим, 3 - ресурсоемкие операции)
    * @param int $messages - количество отображаемых сообщений (0 - не выводить,1 - статистика,
    *  2 - индикатор, 3 - детальная диагностика)
    * @return bool - true в случае выполнения без ошибок
    * @access public
    */
    public function cron($loan,$messages)
    {
        return true;
    }
    /**
        * Обработать задание, отложенное ранее в связи с его длительностью
        * @param string $code - код задания
        * @param int $intvar - дополнительный параметр
        * @param mixed $mixedvar - дополнительные параметры
        * @return bool - true в случае выполнения без ошибок
        * @access public
        */
    public function todo($code,$intvar,$mixedvar)
    {
        return true;
    }
    /**
    * Конструктор
        * @param dof_control $dof - объект $DOF
        * @access public
        */
    public function __construct($dof)
    {
        $this->dof = $dof;
    }
    // **********************************************
    // Методы, предусмотренные интерфейсом im
    // **********************************************
    /**
    * Возвращает содержимое блока
    * @param string $name - название набора текстов для отображания
    * @param int $id - id текста в наборе
    * @return string - html-код названия блока
    */
    function get_block($name, $id = 1)
    {
        return 'empty string';
    }
        
    /** Возвращает содержимое секции
    * @param string $name - название набора текстов для отображания
    * @param int $id - id текста в наборе
    * @return string  - html-код названия секции
    */
    function get_section($name, $id = 1)
    {
        $rez = '';
        switch ($name)
        {
        
        }
        
        return $rez;
    }
    
    /** Возвращает текст для отображения в блоке dof
    * @return string  - html-код для отображения
    */
    public function get_blocknotes()
    {
        return 'empty string';
    }
    
    // ***********************************************************
    //       Методы для работы с полномочиями и конфигурацией
    // ***********************************************************
    
    /** Проверить права через систему полномочий acl
    *
    * @param string $do - идентификатор действия, которое должно быть совершено
    * @param int $objectid - идентификатор экземпляра объекта,
    * по отношению к которому это действие должно быть применено
    * @param int $userid - идентификатор пользователя в Moodle, полномочия которого проверяются
    * @return bool true - можно выполнить указанное действие по отношению к выбранному объекту
    * false - доступ запрещен
    */
    protected function acl_access_check($do, $objectid, $userid)
    {
        
        if ( ! $userid )
        {// получаем id пользователя в persons
            $userid = $this->dof->storage('persons')->get_by_moodleid_id($userid);
        }
        // получаем все нужные параметры для функции проверки прав
        $acldata = $this->get_access_parametrs($do, $objectid, $userid);
         
        switch ( $do )
        {// определяем дополнительные параметры в зависимости от запрашиваемого права
        // для некоторых прав название полномочия заменим на стандартное, для совместимости
        // запрошено неизвестное полномочие
            default: $acldata->code = $do;
        }
        //print_object($acldata);
        // проверка
        if ( $this->acl_check_access_paramenrs($acldata) )
        {// право есть заканчиваем обработку
            return true;
        }
        return false;
    }
    /** Получить список параметров для фунции has_hight()
    * @todo завести дополнительные права в плагине storage/persons и storage/contracts
    * и при редактировании контракта или персоны обращаться к ним
    *
    * @return object - список параметров для фунции has_hight()
    * @param string $action - совершаемое действие
    * @param int $objectid - id объекта над которым совершается действие
    * @param int $userid
    */
    protected function get_access_parametrs($action, $objectid, $userid)
    {
        $result = new object();
        $result->plugintype   = $this->type();
        $result->plugincode   = $this->code();
        $result->code         = $action;
        $result->userid       = $userid;
        $result->departmentid = 1;//optional_param('departmentid', 0, PARAM_INT);
        $result->objectid     = $objectid;
        
        if ( ! $objectid )
        {// если objectid не указан - установим туда 0 чтобы не было проблем с sql-запросами
            $result->objectid = 0;
        }else
        {// если указан - то установим подразделение
            //$result->departmentid = $this->dof->storage('reports')->get_field($objectid, 'departmentid');
        }
        
        return $result;
    }
    
    /** Проверить права через плагин acl.
    * Функция вынесена сюда, чтобы постоянно не писать длинный вызов и не перечислять все аргументы
    *
    * @return bool
    * @param object $acldata - объект с данными для функции storage/acl->has_right()
    */
    protected function acl_check_access_paramenrs($acldata)
    {   
        return $this->dof->storage('acl')->
        has_right($acldata->plugintype, $acldata->plugincode, $acldata->code,
        $acldata->userid, $acldata->departmentid, $acldata->objectid);
    }
    
    /** Возвращает стандартные полномочия доступа в плагине
    * @return array
    *  a[] = array( 'code'  => 'код полномочия',
    * 				 'roles' => array('student' ,'...');
    */
    public function acldefault()
    {
        $a = array();
        $a['view']     = array('roles'=>array('manager', 'teacher'));
        
        return $a;
    }
    
    /** Получить URL к собственным файлам плагина
     * @param string $adds[optional] - фрагмент пути внутри папки плагина
     *                                 начинается с /. Например '/index.php'
     * @param array $vars[optional] - параметры, передаваемые вместе с url
     * @return string - путь к папке с плагином
     * @access public
     */
    public function url($adds='', $vars=array())
    {
        return $this->dof->url_im($this->code(), $adds, $vars);
    }
    
    // **********************************************
    //              Собственные методы
    // **********************************************
    
}

?>